Interface: SegmentationParams

Hierarchy

• RenderParams

  ↳ SegmentationParams

Properties

backgroundBlurAmount

• backgroundBlurAmount: number

Range in between 0 and 20

Default Value

3

Inherited from

RenderParams.backgroundBlurAmount

---

backgroundImage

• backgroundImage: undefined | Canvas

Background image used for background replacement

Inherited from

RenderParams.backgroundImage

---

backgroundImageUrl

• Optional backgroundImageUrl: string

---

edgeBlurAmount

• edgeBlurAmount: number

Range in between 0 and 20

Default Value

3

Inherited from

RenderParams.edgeBlurAmount

---

effects

• effects: "blur" | "none" | "overlay"

Default Value

none

Inherited from

RenderParams.effects

---

flipHorizontal

• flipHorizontal: boolean

Default Value

false

Inherited from

RenderParams.flipHorizontal

---

foregroundThreshold

• foregroundThreshold: number

Range in between 0 and 1

Default Value

0.5

Inherited from

RenderParams.foregroundThreshold

---

height

• height: number

Processing height size

Inherited from

RenderParams.height

---

segmenter

• segmenter: Segmenter

---

width

• width: number

Processing Width size

Inherited from

RenderParams.width

Methods

loadBackgroundImage

▸ loadBackgroundImage(url): Promise<void>

Parameters

Name	Type
url	string

Returns

Promise<void>